3 * Class used for executing shell commands
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 namespace MediaWiki\Shell
;
25 use MediaWiki\MediaWikiServices
;
28 * Executes shell commands
32 * Use call chaining with this class for expressiveness:
33 * $result = Shell::command( 'some command' )
34 * ->environment( [ 'ENVIRONMENT_VARIABLE' => 'VALUE' ] )
35 * ->limits( [ 'time' => 300 ] )
38 * ... = $result->getExitCode();
39 * ... = $result->getStdout();
40 * ... = $result->getStderr();
45 * Returns a new instance of Command class
47 * @param string|string[] $command String or array of strings representing the command to
48 * be executed, each value will be escaped.
49 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
52 public static function command( $command ) {
53 $args = func_get_args();
54 if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
55 // If only one argument has been passed, and that argument is an array,
56 // treat it as a list of arguments
57 $args = reset( $args );
59 $command = MediaWikiServices
::getInstance()
60 ->getShellCommandFactory()
63 return $command->params( $args );
67 * Check if this class is effectively disabled via php.ini config
71 public static function isDisabled() {
72 static $disabled = null;
74 if ( is_null( $disabled ) ) {
75 if ( !function_exists( 'proc_open' ) ) {
76 wfDebug( "proc_open() is disabled\n" );
87 * Version of escapeshellarg() that works better on Windows.
89 * Originally, this fixed the incorrect use of single quotes on Windows
90 * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
91 * PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
93 * @param string $args,... strings to escape and glue together, or a single array of
97 public static function escape( /* ... */ ) {
98 $args = func_get_args();
99 if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
100 // If only one argument has been passed, and that argument is an array,
101 // treat it as a list of arguments
102 $args = reset( $args );
107 foreach ( $args as $arg ) {
114 if ( wfIsWindows() ) {
115 // Escaping for an MSVC-style command line parser and CMD.EXE
116 // @codingStandardsIgnoreStart For long URLs
118 // * https://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
119 // * https://technet.microsoft.com/en-us/library/cc723564.aspx
122 // Double the backslashes before any double quotes. Escape the double quotes.
123 // @codingStandardsIgnoreEnd
124 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
127 foreach ( $tokens as $token ) {
128 if ( $iteration %
2 == 1 ) {
129 // Delimiter, a double quote preceded by zero or more slashes
130 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
131 } elseif ( $iteration %
4 == 2 ) {
132 // ^ in $token will be outside quotes, need to be escaped
133 $arg .= str_replace( '^', '^^', $token );
134 } else { // $iteration % 4 == 0
135 // ^ in $token will appear inside double quotes, so leave as is
140 // Double the backslashes before the end of the string, because
141 // we will soon add a quote
143 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
144 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
147 // Add surrounding quotes
148 $retVal .= '"' . $arg . '"';
150 $retVal .= escapeshellarg( $arg );